docs: Update github-runner-operator to Mature home page milestone#801
Conversation
yanksyoon
requested review from
cbartz,
florentianayuwono,
javierdelapuente,
weiiwang01 and
yhaliaw
as code owners
erinecon
left a comment
erinecon
left a comment
There was a problem hiding this comment.
Thank you so much for working on the home page 🎉 the great news for us is that we have a lot of pages and content to work with :D but this also means that the review will likely take a few rounds as I'll dig into the docs in greater detail. Thanks in advance for your patience!
I've limited this first round (mostly) to suggesting pages and categories for the table
- Reorder Get started row with Quick start first - Move Managing resource usage from Tutorial to Explanation - Enhance Deployment row with Change repository/authentication pages - Add LXD runners row with custom labels, base image, troubleshoot - Rename 'Product-specific feature' to 'LXD runners' - Enhance Design row with Integrations and ARM64 pages - Expand Security row with all suggested security-related pages - Use bullet separators instead of pipes for better rendering - Remove Release notes from documentation organization section - Remove Changelog from Contents list - Move Managing resource usage and Security to Explanation section Addresses all comments from erinecon on PR #801
- Reorder Get started row with Quick start first - Move Managing resource usage from Tutorial to Explanation - Enhance Deployment row with Change repository/authentication pages - Add LXD runners row with custom labels, base image, troubleshoot - Rename 'Product-specific feature' to 'LXD runners' - Enhance Design row with Integrations and ARM64 pages - Expand Security row with all suggested security-related pages - Use bullet separators instead of pipes for better rendering - Remove Release notes from documentation organization section - Remove Changelog from Contents list - Move Managing resource usage and Security to Explanation section Addresses all comments from erinecon on PR #801
yanksyoon
force-pushed
the
docs/mature-home-milestone-isd-5894
branch
from
837b789 to
35caa5f
Compare
erinecon
left a comment
erinecon
left a comment
There was a problem hiding this comment.
Some general questions (which would probably lead to follow-up issues or PRs) and a nit
yhaliaw
left a comment
yhaliaw
left a comment
There was a problem hiding this comment.
This PR restructures docs/index.md with a navigation grid, a Diátaxis orientation section, reorganized community links, and normalized TOC indentation with relative link targets — a solid documentation improvement. All link targets check out and the writing is clean; the inline comments flag two small label-consistency and categorization issues.
One out-of-diff note: the prose pointer explaining the local-lxd variant ("If you want to use ephemeral LXD virtual machines…") was removed in favor of the navigation grid. Consider adding a brief one-liner above or near the grid to preserve that discoverability for readers who arrive at the page without prior context (docs/index.md, around the former line 30 area).
🤝 Human review with AI assistance.
- Change 'Quick start' link label to 'Deploy the GitHub runner charm' for clarity (erinecon nit) - Update Diátaxis Tutorials description with local-lxd context (yhaliaw, erinecon) - Move managing-resource-usage.md from tutorial/ to explanation/ to match its actual category (yhaliaw, erinecon) - Add one-liner about local-lxd variant above navigation grid (yhaliaw out-of-diff note)
erinecon
left a comment
erinecon
left a comment
There was a problem hiding this comment.
Spotted a few more nits, but I think the home page is really coming together 🎉 thank you so much for all your work on the home page!
Co-authored-by: Erin Conley <erin.conley@canonical.com>
Co-authored-by: Erin Conley <erin.conley@canonical.com>
Co-authored-by: Erin Conley <erin.conley@canonical.com>
…com/canonical/github-runner-operator into docs/mature-home-milestone-isd-5894
3 participants
What this PR does
Update to latest home page milestone
Why we need it
Documentation quality sync
Checklist
docs/changelog.mdwith user-relevant changesterraform fmtpasses andtflintreports no errorsgithub-runner-manager/pyproject.toml.Only documentation change.